gtk_accel_label_refetch
gtk_accel_label_set_label
gtk_accel_label_get_label
+gtk_accel_label_get_use_underline
+gtk_accel_label_set_use_underline
<SUBSECTION Standard>
GTK_ACCEL_LABEL
GTK_IS_ACCEL_LABEL
<SUBSECTION Private>
GtkAssistantPrivate
gtk_assistant_get_type
+gtk_assistant_page_get_type
</SECTION>
<SECTION>
gtk_calendar_unmark_day
gtk_calendar_get_day_is_marked
gtk_calendar_clear_marks
+gtk_calendar_get_show_day_names
+gtk_calendar_set_show_day_names
+gtk_calendar_get_show_heading
+gtk_calendar_set_show_heading
+gtk_calendar_get_show_week_numbers
+gtk_calendar_set_show_week_numbers
<SUBSECTION>
gtk_calendar_get_date
gtk_label_set_attributes
gtk_label_set_markup
gtk_label_set_markup_with_mnemonic
-gtk_label_set_pattern
gtk_label_set_justify
gtk_label_set_xalign
gtk_label_set_yalign
gtk_label_set_use_underline
gtk_label_set_single_line_mode
gtk_label_get_current_uri
-gtk_label_set_track_visited_links
-gtk_label_get_track_visited_links
gtk_label_set_extra_menu
gtk_label_get_extra_menu
gtk_menu_button_get_label
gtk_menu_button_set_has_frame
gtk_menu_button_get_has_frame
+gtk_menu_button_get_use_underline
+gtk_menu_button_set_use_underline
gtk_menu_button_popup
gtk_menu_button_popdown
GtkMenuButtonCreatePopupFunc
<TITLE>GtkViewport</TITLE>
GtkViewport
gtk_viewport_new
+gtk_viewport_set_scroll_to_focus
+gtk_viewport_get_scroll_to_focus
<SUBSECTION Standard>
GTK_VIEWPORT
GTK_IS_VIEWPORT
gtk_widget_class_add_shortcut
gtk_widget_class_add_binding
gtk_widget_class_add_binding_signal
+gtk_widget_class_add_binding_action
+gtk_widget_class_set_layout_manager_type
+gtk_widget_class_get_layout_manager_type
gtk_widget_activate
gtk_widget_is_focus
gtk_widget_grab_focus
gtk_event_controller_set_propagation_limit
gtk_event_controller_get_widget
gtk_event_controller_reset
+gtk_event_controller_get_name
+gtk_event_controller_set_name
<SUBSECTION>
gtk_event_controller_get_current_event
GtkAlternativeTrigger
gtk_alternative_trigger_new
gtk_alternative_trigger_get_first
+gtk_alternative_trigger_get_second
<SUBSECTION>
GtkNeverTrigger
<TITLE>GtkShortcutController</TITLE>
GtkShortcutController
gtk_shortcut_controller_new
-gtk_shortcut_controller_new_with_model
+gtk_shortcut_controller_new_for_model
GtkShortcutScope
GtkShortcutManager
GtkShortcutManagerInterface
* @GTK_LICENSE_LGPL_3_0_ONLY: The GNU Lesser General Public License, version 3.0 only
* @GTK_LICENSE_AGPL_3_0: The GNU Affero General Public License, version 3.0 or later
* @GTK_LICENSE_AGPL_3_0_ONLY: The GNU Affero General Public License, version 3.0 only
+ * @GTK_LICENSE_BSD_3: The 3-clause BSD licence
+ * @GTK_LICENSE_APACHE_2_0: The Apache License, version 2.0
+ * @GTK_LICENSE_MPL_2_0: The Mozilla Public License, version 2.0
*
* The type of license for an application.
*
}
/**
- * gtk_Button_set_has_frame:
+ * gtk_button_set_has_frame:
* @button: a #GtkButton
* @has_frame: whether the button should have a visible frame
*
* gtk_calendar_get_date:
* @self: a #GtkCalendar
*
- * Returns: (transfer full): A #GDateTime representing the shown
- * year, month and the selected day, in the local time zone.
+ * Returns a #GDateTime representing the shown
+ * year, month and the selected day, in the local
+ * time zone.
+ *
+ * Returns: (transfer full): the #GDate representing
+ * the shown date.
*/
GDateTime *
gtk_calendar_get_date (GtkCalendar *self)
}
/**
- * gtk_calendar_set_show_week_numbers
+ * gtk_calendar_set_show_week_numbers:
* @self: a #GtkCalendar
- * @value: Whether to show week numbers on the left of the days
+ * @value: whether to show week numbers on the left of the days
*
* Sets whether week numbers are shown in the calendar.
*/
* gtk_calendar_get_show_week_numbers:
* @self: a #GtkCalendar
*
- * Returns: Whether @self is showing week numbers right now,
- * i.e. the value of the #GtkCalendar:show-week-numbers property.
+ * Returns whether @self is showing week numbers right
+ * now, i.e. the value of the #GtkCalendar:show-week-numbers
+ * property.
+ *
+ * Return: Whether the calendar is showing week numbers.
*/
gboolean
gtk_calendar_get_show_week_numbers (GtkCalendar *self)
/**
* gtk_calendar_set_show_heading:
* @self: a #GtkCalendar
- * @value: Whether to show the heading in the calendar,
- * containing the current year and month as well as
- * buttons for changing both.
+ * @value: Whether to show the heading in the calendar
+ *
+ * Sets whether the calendar should show a heading
+ * containing the current year and month as well as
+ * buttons for changing both.
*/
void
gtk_calendar_set_show_heading (GtkCalendar *self,
* gtk_calendar_get_show_heading:
* @self: a #GtkCalendar
*
- * Returns: Whether @self is currently showing the heading,
- * i.e. the value of the #GtkCalendar:show-heading property.
+ * Returns whether @self is currently showing the heading,
+ * i.e. the value of the #GtkCalendar:show-heading property.
+ *
+ * Return: Whether the calendar is showing a heading.
*/
gboolean
gtk_calendar_get_show_heading (GtkCalendar *self)
/**
* gtk_calendar_set_show_day_names:
* @self: a #GtkCalendar
- * @value: Whether to show week day names above the
- * day numbers
+ * @value: Whether to show day names above the day numbers
+ *
+ * Sets whether the calendar shows day names.
*/
void
gtk_calendar_set_show_day_names (GtkCalendar *self,
}
/**
- * gtk_calendar_get_day_names:
+ * gtk_calendar_get_show_day_names:
* @self: a #GtkCalendar
*
- * Returns: Whether @self is currently showing the names
- * of the week days above the day numbers, i.e. the value
- * of the #GtkCalendar:show-day-names property.
+ * Returns whether @self is currently showing the names
+ * of the week days above the day numbers, i.e. the value
+ * of the #GtkCalendar:show-day-names property.
+ *
+ * Returns: Whether the calendar shows day names.
*/
gboolean
gtk_calendar_get_show_day_names (GtkCalendar *self)
* gtk_center_layout_get_orientation:
* @self: a #GtkCenterLayout
*
+ * Gets the current orienration of the layout manager.
*
* Returns: The current orientation of @self
*/
* gtk_center_layout_get_baseline_position:
* @self: a #GtkCenterLayout
*
+ * Returns the baseline position of the layout.
+ *
* Returns: The current baseline position of @self.
*/
GtkBaselinePosition
* gtk_center_layout_get_start_widget:
* @self: a #GtkCenterLayout
*
+ * Returns the start widget fo the layout.
+ *
* Returns: (transfer none): The current start widget of @self
*/
GtkWidget *
* gtk_center_layout_get_center_widget:
* @self: a #GtkCenterLayout
*
+ * Returns the center widget of the layout.
+ *
* Returns: (transfer none): the current center widget of @self
*/
GtkWidget *
* gtk_center_layout_get_end_widget:
* @self: a #GtkCenterLayout
*
+ * Returns the end widget of the layout.
+ *
* Returns: (transfer none): the current end widget of @self
*/
GtkWidget *
gtk_widget_class_bind_template_callback (widget_class, long_pressed_cb);
gtk_widget_class_bind_template_callback (widget_class, keynav_failed);
+ /**
+ * GtkEmojiChooser|scroll.section:
+ * @direction: 1 to scroll forward, -1 to scroll back
+ *
+ * Scrolls to the next or previous section.
+ */
gtk_widget_class_install_action (widget_class, "scroll.section", "i",
gtk_emoji_chooser_scroll_section);
g_object_notify_by_pspec (G_OBJECT (controller), properties[PROP_PROPAGATION_PHASE]);
}
+/**
+ * gtk_event_controller_get_propagation_limit:
+ * @controller: a #GtkEventController
+ *
+ * Gets the propagation limit of the event controller.
+ *
+ * Returns: the propagation limit
+ */
GtkPropagationLimit
gtk_event_controller_get_propagation_limit (GtkEventController *controller)
{
return priv->limit;
}
+
+/**
+ * gtk_event_controller_set_propagation_limit:
+ * @controller: a #GtkEventController
+ * @limit: the propagation limit
+ *
+ * Sets the event propagation limit on the event controller.
+ *
+ * If the limit is set to %@GTK_LIMIT_SAME_NATIVE, the controller
+ * won't handle events that are targeted at widgets on a different
+ * surface, such as popovers.
+ */
void
gtk_event_controller_set_propagation_limit (GtkEventController *controller,
GtkPropagationLimit limit)
g_object_notify_by_pspec (G_OBJECT (controller), properties[PROP_PROPAGATION_LIMIT]);
}
+/**
+ * gtk_event_controller_get_name:
+ * @controller: a #GtkEventController
+ *
+ * Gets the name of @controller.
+ */
const char *
gtk_event_controller_get_name (GtkEventController *controller)
{
return priv->name;
}
+/**
+ * gtk_event_controller_set_name:
+ * @controller: a #GtkEventController
+ * @name: a name for @controller
+ *
+ * Sets a name on the controller that can be used for
+ * debugging.
+ */
void
gtk_event_controller_set_name (GtkEventController *controller,
const char *name)
}
/**
- * gtk_gesture_long_press_set_property:
+ * gtk_gesture_long_press_set_delay_factor:
* @gesture: A #GtkGestureLongPress
* @delay_factor: The delay factor to apply
*
* Applies the given delay factor. The default long press time will be
- * multiplied by this value.
- * Valid values are in the range [0.5..2.0].
+ * multiplied by this value. Valid values are in the range [0.5..2.0].
*/
void
gtk_gesture_long_press_set_delay_factor (GtkGestureLongPress *gesture,
}
/**
- * gtk_gesture_long_press_get_property:
+ * gtk_gesture_long_press_get_delay_factor:
* @gesture: A #GtkGestureLongPress
*
* Returns the delay factor as set by gtk_gesture_long_press_set_delay_factor().
+ *
+ * Returns: the delay factor
*/
double
gtk_gesture_long_press_get_delay_factor (GtkGestureLongPress *gesture)
quark_mnemonics_visible_connected = g_quark_from_static_string ("gtk-label-mnemonics-visible-connected");
+ /**
+ * GtkLabel|clipboard.cut:
+ *
+ * Doesn't do anything, since text in labels can't be deleted.
+ */
gtk_widget_class_install_action (widget_class, "clipboard.cut", NULL,
gtk_label_nop);
+
+ /**
+ * GtkLabel|clipboard.copy:
+ *
+ * Copies the text to the clipboard.
+ */
gtk_widget_class_install_action (widget_class, "clipboard.copy", NULL,
gtk_label_activate_clipboard_copy);
+
+ /**
+ * GtkLabel|clipboard.paste:
+ *
+ * Doesn't do anything, since text in labels can't be edited.
+ */
gtk_widget_class_install_action (widget_class, "clipboard.paste", NULL,
gtk_label_nop);
+
+ /**
+ * GtkLabel|selection.delete:
+ *
+ * Doesn't do anything, since text in labels can't be deleted.
+ */
gtk_widget_class_install_action (widget_class, "selection.delete", NULL,
gtk_label_nop);
+
+ /**
+ * GtkLabel|selection.select-all:
+ *
+ * Selects all of the text, if the label allows selection.
+ */
gtk_widget_class_install_action (widget_class, "selection.select-all", NULL,
gtk_label_activate_selection_select_all);
+
+ /**
+ * GtkLabel|link.open:
+ *
+ * Opens the link, when activated on a link inside the label.
+ */
gtk_widget_class_install_action (widget_class, "link.open", NULL,
gtk_label_activate_link_open);
+
+ /**
+ * GtkLabel|link.copy:
+ *
+ * Copies the link to the clipboard, when activated on a link
+ * inside the label.
+ */
gtk_widget_class_install_action (widget_class, "link.copy", NULL,
gtk_label_activate_link_copy);
}
update_sensitivity (menu_button);
}
+/**
+ * gtk_menu_button_set_use_underline:
+ * @menu_button: a #GtkMenuButton
+ * @use_underline: %TRUE if underlines in the text indicate mnemonics
+ *
+ * If true, an underline in the text indicates the next character should be
+ * used for the mnemonic accelerator key.
+ */
void
gtk_menu_button_set_use_underline (GtkMenuButton *menu_button,
gboolean use_underline)
g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_USE_UNDERLINE]);
}
+/**
+ * gtk_menu_button_get_use_underline:
+ * @menu_button: a #GtkMenuButton
+ *
+ * Returns whether an embedded underline in the text indicates a
+ * mnemonic. See gtk_menu_button_set_use_underline().
+ *
+ * Returns: %TRUE whether an embedded underline in the text indicates
+ * the mnemonic accelerator keys.
+ */
gboolean
gtk_menu_button_get_use_underline (GtkMenuButton *menu_button)
{
gtk_widget_class_set_css_name (widget_class, "popover");
}
+/**
+ * gtk_popover_new:
+ *
+ * Creates a new popover.
+ *
+ * Returns: the new popover
+ */
GtkWidget *
gtk_popover_new (void)
{
return g_object_new (GTK_TYPE_POPOVER, NULL);
}
+/**
+ * gtk_popover_set_default_widget:
+ * @popover: a #GtkPopover
+ * @widget: (allow-none): a child widget of @popover to set as
+ * the default, or %NULL to unset the default widget for the popover
+ *
+ * The default widget is the widget that’s activated when the user
+ * presses Enter in a dialog (for example). This function sets or
+ * unsets the default widget for a #GtkPopover.
+ */
void
gtk_popover_set_default_widget (GtkPopover *popover,
GtkWidget *widget)
}
/**
- * gtk_popover_menu_set_model:
+ * gtk_popover_menu_set_menu_model:
* @popover: a #GtkPopoverMenu
* @model: (nullable): a #GtkMenuModel, or %NULL
*
}
}
+/**
+ * gtk_shortcut_get_arguments:
+ * @self: a #GtkShortcut
+ *
+ * Gets the arguments that are passed when activating the shortcut.
+ *
+ * Returns: (transfer none) (nullable): the arguments
+ */
GVariant *
gtk_shortcut_get_arguments (GtkShortcut *self)
{
return self->args;
}
+/**
+ * gtk_shortcut_set_arguments:
+ * @self: a #GtkShortcut
+ * @args: (nullable): arguments to pass when activating @self
+ *
+ * Sets the arguments to pass when activating the shortcut.
+ */
void
gtk_shortcut_set_arguments (GtkShortcut *self,
GVariant *args)
* @uri: the uri to show
* @timestamp: timestamp from the event that triggered this call, or %GDK_CURRENT_TIME
* @cancellable: (nullable): a #GCancellable to cancel the launch
- * @callback (scope async): a callback to call when the action is complete
+ * @callback: (scope async): a callback to call when the action is complete
* @user_data: (closure callback): data to pass to @callback
*
* This function launches the default application for showing
* CSS nodes starting at the style context's node
* @GTK_STYLE_CONTEXT_PRINT_SHOW_STYLE: Show the values of the
* CSS properties for each node
+ * @GTK_STYLE_CONTEXT_PRINT_SHOW_CHANGE: Show information about
+ * what changes affect the styles
*
* Flags that modify the behavior of gtk_style_context_to_string().
* New values may be added to this enumeration.
gtk_text_activate_clipboard_copy);
/**
- * GtkText|clipboard.copy:
+ * GtkText|clipboard.paste:
*
* Inserts the contents of the clipboard into the widget.
*/
gtk_widget_class_install_action (widget_class, "misc.insert-emoji", NULL,
gtk_text_activate_misc_insert_emoji);
+ /**
+ * GtkText|misc.toggle-visibility:
+ *
+ * Toggles the #GtkText:visibility property.
+ */
gtk_widget_class_install_property_action (widget_class,
"misc.toggle-visibility",
"visibility");
gtk_text_history_redo (buffer->priv->history);
}
+/**
+ * gtk_text_buffer_get_can_undo:
+ * @buffer: a #GtkTextBuffer
+ *
+ * Gets whether there is an undoable action in the history.
+ *
+ * Returns: %TRUE if there is an undoable action
+ */
gboolean
gtk_text_buffer_get_can_undo (GtkTextBuffer *buffer)
{
return gtk_text_history_get_can_undo (buffer->priv->history);
}
+/**
+ * gtk_text_buffer_get_can_redo:
+ * @buffer: a #GtkTextBuffer
+ *
+ * Gets whether there is a redoable action in the history.
+ *
+ * Returns: %TRUE if there is an redoable action
+ */
gboolean
gtk_text_buffer_get_can_redo (GtkTextBuffer *buffer)
{
/**
* gtk_text_buffer_set_enable_undo:
* @buffer: a #GtkTextBuffer
+ * @enable_undo: %TRUE to enable undo
*
* Sets whether or not to enable undoable actions in the text buffer. If
* enabled, the user will be able to undo the last number of actions up to
*/
void
gtk_text_buffer_set_enable_undo (GtkTextBuffer *buffer,
- gboolean enabled)
+ gboolean enable_undo)
{
g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
- if (enabled != gtk_text_history_get_enabled (buffer->priv->history))
+ if (enable_undo != gtk_text_history_get_enabled (buffer->priv->history))
{
- gtk_text_history_set_enabled (buffer->priv->history, enabled);
+ gtk_text_history_set_enabled (buffer->priv->history, enable_undo);
g_object_notify_by_pspec (G_OBJECT (buffer),
text_buffer_props[PROP_ENABLE_UNDO]);
}
}
}
-/**
+/*
* gtk_text_layout_set_buffer:
* @buffer: (allow-none):
*/
}
-/**
+/*
* gtk_text_layout_get_lines:
*
* Returns: (element-type GtkTextLine) (transfer container):
gtk_widget_queue_allocate (GTK_WIDGET (data));
}
+/**
+ * gtk_viewport_get_scroll_to_focus:
+ * @viewport: a #GtkViewport
+ *
+ * Gets whether the viewport is scrolling to keep the focused
+ * child in view. See gtk_viewport_set_scroll_to_focus().
+ *
+ * Returns: %TRUE if the viewport keeps the focus child scrolled to view
+ */
gboolean
gtk_viewport_get_scroll_to_focus (GtkViewport *viewport)
{
return priv->scroll_to_focus;
}
+/**
+ * gtk_viewport_set_scroll_to_focus:
+ * @viewport: a #GtkViewport
+ * @scroll_to_focus: whether to keep the focus widget scrolled to view
+ *
+ * Sets whether the viewport should automatically scroll
+ * to keep the focused child in view.
+ */
void
gtk_viewport_set_scroll_to_focus (GtkViewport *viewport,
gboolean scroll_to_focus)
priv->actions = action;
}
-/*
+/**
* gtk_widget_class_install_action:
* @widget_class: a #GtkWidgetClass
* @action_name: a prefixed action name, such as "clipboard.paste"
* Installs an action called @action_name on @widget_class and binds its
* state to the value of the @property_name property.
*
- * This function will perform a few santity checks on the property selected via
- * @property_name. Namely, the property must exist, must be readable, writable and
- * must not be construct-only. There are also certain restrictions on the type of
- * the given property. If any of these conditions are not met, a critical
+ * This function will perform a few santity checks on the property selected
+ * via @property_name. Namely, the property must exist, must be readable,
+ * writable and must not be construct-only. There are also restrictions
+ * on the type of the given property, it must be boolean, int, unsigned int,
+ * double or string. If any of these conditions are not met, a critical
* warning will be printed and no action will be added.
+ *
+ * The state type of the action matches the property type.
+ *
+ * If the property is boolean, the action will have no parameter and
+ * toggle the property value. Otherwise, the action will have a parameter
+ * of the same type as the property.
*/
void
gtk_widget_class_install_property_action (GtkWidgetClass *widget_class,
projects / gtk4.git / commitdiff